Update docs to use relative code links.#1447
Merged
lalitb merged 3 commits intoopen-telemetry:mainfrom Jul 1, 2022
Merged
Conversation
lalitb
approved these changes
Jun 11, 2022
Member
lalitb
left a comment
lalitb
left a comment
There was a problem hiding this comment.
Thanks. LGTM with a minor fix.
Codecov Report
@@ Coverage Diff @@
## main #1447 +/- ##
=======================================
Coverage 85.31% 85.31%
=======================================
Files 154 154
Lines 4377 4377
=======================================
Hits 3734 3734
Misses 643 643 |
jpeach
force-pushed
the
relative-docs-links
branch
from
1186a8d to
00a4ef9
Compare
Contributor
Author
|
docfx hates this apparently |
Member
Yes, I think we can fix |
Contributor
|
Could we please try remove the prefix |
Use relative links to locations within the same repository. This means that in the Github UI the reader will follow the link to the location in the same branch rather than to a fixed, predetermined branch. Signed-off-by: James Peach <jpeach@cloudflare.com>
jpeach
force-pushed
the
relative-docs-links
branch
from
507be83 to
28f5032
Compare
Contributor
Author
|
Updated to use root-relative links, and docfx seems happy. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Use relative links to locations within the same repository. This means
that in the Github UI the reader will follow the link to the location
in the same branch rather than to a fixed, predetermined branch.